ResultArg

@ApiStatus.Experimental

abstract class ResultArg<V, R> @JvmOverloads constructor(arg: String, fallback: R, noValueArg: Boolean = false)

A key for handling a scope argument for a ResultProvider

fzzyhmstrs

0.5.3

the value type received by this arg for processing

the result type provided by processing

arg

String key used in the scope passed to the provider. for example a boolean arg "test" would have a scope my.example.scope?test=false

fallback

R a fallback value in case processing or argument parsing fails

noValueArg

Optional boolean, if true the scope string will not need an =value clause: my.example.scope?noValue?valueNeeded=true

Constructors

constructor(arg: String, fallback: R, noValueArg: Boolean = false)

@ApiStatus.Experimental

A ResultArg that calls a provided result consumer when the arg is applied. This is used in multi-arg result processing

@ApiStatus.Experimental

abstract fun applyArg(scopeValue: V, argValue: String): R

Applies the parsed arg value to a scoped config value and returns the processing result

@ApiStatus.Experimental

Converts this ResultArg into a Processor of the same type that calls the provided consumer.